home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Night Owl 6
/
Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso
/
001a
/
com_and3.zip
/
BBS.DOC
< prev
next >
Wrap
Text File
|
1989-10-09
|
21KB
|
935 lines
COM-AND Scripted BBS
------------------------------------------
COM-AND Scripted BBS
Script based Bulletin Board for the IBM PC
------------------------------------------
COM-AND is distributed freely and may be copied by anyone for
any number of machines, for purposes of evaluation. The author
offers COM-AND and its accessory programs as a package, as
"shareware". If you USE the program a registration of $35.00 is
required. The author may be reached:
CABER Software
R. (Scott) McGinnis
P.O. Box 3607 Mdse Mart
Chicago, IL 60654-0607
PLINK, GEnie id: TARTAN
CID is: 73147,2665
Version 1.0: 891009
COM-AND Scripted BBS
Table of Contents
-----------------
I. Introduction .............................................. page 1
II. Installing the BBS ......................................... page 2
III. Logon ...................................................... page 3
IV. Bulletins .................................................. page 4
V. Mail ....................................................... page 5
VI. Files (Upload and Download) ................................ page 6
VII. Chat mode .................................................. page 7
VIII. Privileged commands ........................................ page 8
IX. Program Requirements ....................................... page 9
X. Program and Author Information ............................ page 10
Appendices
----------
A. Required and optional files ................................ page 11
B. File structures ............................................ page 12
C. Maintenance ................................................ page 13
D. Modem configuration ........................................ page 14
E. Sample files ............................................... page 15
Version 1.0: 891009
COM-AND Scripted BBS Page 1
I. Introduction
A. What is COM-AND?
COM-AND for the IBM PC and compatibles is a communications
program that may be used by itself, or with several integrated
accessory programs (which themselves may be used independently of
COM-AND). COM-AND provides standard comm program functions: a
dialing directory, macros, disc logging, binary and ASCII file
transfers, scripted execution and so on.
B. The BBS script
This document details the BBS script provided with version 2.5 of
COM-AND. The BBS script supports
o 300/1200/2400 baud autoanswer
o Reliable use whether the modem reports true CD or no
o Access by ID and password
.. SYSOP must post ID and password to grant access
.. the BBS supports a 'registration' function which could
automatically post a new ID/password, but does not now
.. two privilege levels
.. time limit for non privileged
o Comments to SYSOP from callers
o SYSOP posted bulletins
o Public and private mail
o File upload and download
.. WXMODEM, XMODEM,YMODEM and KERMIT
.. Uploads are not included in time limit computation
o SYSOP-to-caller chat mode (initiated by SYSOP)
Version 1.0: 891009
COM-AND Scripted BBS Page 2
II. Installation
A. Create a subdirectory \BBS
The only file required in this subdirectory is BBS-User, which
specifies IDs and passwords for callers. Modify the supplied
BBS-User file with any ASCII text editor (ASCII files are also
known as non-document format).
B. Create a subdirectory \BBS\FILES
On this subdirectory, the file BBS-FILE contains a list of files
available for downloading, and newly uploaded. If BBS-FILE does
not exit, the script will create it.
Uploads are appended to the end of this file. I recommend that
the new SYSOP initially create a BBS-FILE in this subdirectory.
It contains comments indicating new uploads.
The script will create this file if it does not exist.
C. Create a subdirectory \BBS\MAIL
On this subdirectory, the script expects to find the file
BBS-MAIL. This file is used to scan, read and list messages.
Entries in this file point to single files, each of which
represents a single message.
The script will create this file if it does not exist.
D. Create a subdirectory \BBS\BULLETIN
On this subdirectory, the script expects to find the file
BBS-BULL. This file is used to list and to read bulletins.
Entries in this file point to single files, each of which
represents a single bulletin.
The script will create this file if it does not exist.
E. To start, type:
"d"> COM-AND/fBBS-SRC (from anywhere)
Version 1.0: 891009
COM-AND Scripted BBS Page 3
III. Logon
Callers to this BBS must be identified through and ID and password
in the BBS-User file. The posting if IDs and passwords is a manual
process at this time.
New callers may 'register'... their name/address/telephone and
requested ID/password are logged to the BBS-NOTE file for SYSOp
review.
Two privilege levels are supported at this time. Non-privileged
callers are granted 60 minutes of connect time per call. Privileged
users are granted unlimited connect. Note that non-privileged
callers may call back. The BBS does not record time used accross a
day.
Version 1.0: 891009
COM-AND Scripted BBS Page 4
IV. Bulletins
The B)ulletin submenu supports the following user commands:
o L)ist List available bulletins
o # Read a specific bulletin
The list of available bulletins is taken from the file BBS-BULL.
Comments in the file are not printed for the caller to see.
Bulletin numbers may be arbitrarily assigned, and certain bulletins
may be restricted to privileged callers only.
The caller selects a bulletin number to view from the list supplied.
The bulletin is transferred using an ASCII send function: control-
S and control-Q may be used to suspend the transfer.
Version 1.0: 891009
COM-AND Scripted BBS Page 5
V. Mail
The M)ail submenu supports the following user commands:
o S)can Scan postings for mail 'to' the caller
o L)ist List mail (to,from,date,subject)
o R)ead Read mail (to caller, and public posts)
o W)rite Write a message (public or private)
This script does not support editing of postings at this time.
The list of pending mail is taken from the file BBS-MAIL. Comments
in the file are not printed for the caller to see. Mail is only
readable sequentially (at this time). Mail is marked 'private' to
receiver when it is created.
The mail file is not automatically purged of entries older than a
given date. Such a script would be easily written - at this time
however, its a manual task.
Version 1.0: 891009
COM-AND Scripted BBS Page 6
VI. Files (download and Upload)
The F)iles submenu supports the following user commands:
o L)ist List available files
o S)earch Search the file list for a substring
o U)pload Upload a file (to the board)
o D)ownload Download a file (from the board)
Files may be uploaded and downloaded from this script using:
o WXMODEM (Windowed XMODEM)
o XMODEM (CRC or checksum)
o YMODEM (CRC or checksum)
o KERMIT (Windowed or plain)
Non-privileged callers are not allowed to upload files that
duplicate files on the \BBS\Files subdirectory.
Non-privileged callers are limited to downloading files on the
\BBS\Files subdirectory (not necessarily all listed in the file
BBS-FILE).
Privileged callers may upload/download to/from any accessible disc
device and subdirectory.
Uploads are noted in the \BBS-FILE file with a caller supplied
description.
Version 1.0: 891009
COM-AND Scripted BBS Page 7
VII. Chat with SYSOP
The A)larm command at the main prompt sounds a tune on the local
console's speaker. If the SYSOP wishes to respond the SYSOP may
interrupt the caller (whether the ALARM has been used or no) with
the ESCape key.
Pressing the ESCape key during the script's operation will interrupt
the script - however, the caller is not disconnected immediately.
The SYSOP may choose to terminate the script (in which case a HANGUP
is performed). The SYSOP may alternately choose to CHAT with the
caller.
When the SYSOP chooses CHAT, the caller is informed of operator
intervention. The SYSOP is prompted for a line of text (blank lines
entered by the SYSOP result in a query: "Continue" and are the means
for termination of the CHAT). When the SYSOP presses CR, any text
is sent to the caller and the caller is prompted for text. The chat
continues back and forth, one line at a time, until the caller
disconnects or the SYSOP terminates the chat.
At this time, time spent in CHAT is not added back to the caller's
total time alotment.
Version 1.0: 891009
COM-AND Scripted BBS Page 8
VIII. Privileged access
Users flagged in the BBS-User file with privileged access are
allowed an additional main prompt command ("P"). The "Privilege"
command gives access to a submenu with the commands:
o L)ist performs a DIR on the current subdirectory
o S)ubdir changes the current drive:subdirectory
o P)ath provides a graphics display of the tree structure
of the current default disc (required the P/d
utility TREED.COM)
o D)os performs a DOS command
Version 1.0: 891009
COM-AND Scripted BBS Page 9
IX. Program requirements
This program can only function on an IBM PC or DOS compatible
machine. COM-AND does direct to screen buffer fetches and stores
(unless BIOS screen updates are directed using the /C switch or the
Alt-O options menu).
COM-AND is TopView aware even without the /C switch or Alt-O option.
COM-AND supports MDA, CGA, EGA and Hercules. COM-AND uses a Micro-
soft Mouse if one is available...
COM-AND disk I/O is done through the 'Handle' oriented I/O routines
added to DOS 2.0. Therefore DOS 2.0 is a minimum requirement.
COM-AND (Version 2.5) requires 248K for itself. You need 384K to
take advantage of the DOS Gateway and to load accessories.
This script requires a 300, 1200 or 2400 baud modem. [Others could
be supported with modification to the script.] This script is most
reliable if the modem is set to report true CD.
And of course, for a Bulletin Board, you need a lot of disc
freespace!
Version 1.0: 891009
COM-AND Scripted BBS Page 10
X. Author information
COM-AND was written using Microsoft Macro-Assembler. The
author likes assembler. Assembly language is an entirely
appropriate vehicle for some of the program, and a not-inappro-
priate vehicle for the rest of it. Everything, in moderation...
The author of this program is R. Scott McGinnis of Chicago,
Illinois. PLINK and GEnie ID: TARTAN. Comment and suggestions
(and criticism in moderation) are welcomed:
CABER Software
R. (Scott) McGinnis
P.O. Box 3607 Mdse Mart
Chicago, IL 60654-0607
I want to thank Mike Todd (SYSOP of the IBM PC SIG on the SOURCE)
and John Poindexter for their valuable comments and gripes on the
2.1 version of COM-AND script language. This BBS script was in
fact created to test the script changes made for version 2.2.
I also thank my wife, Elizabeth, who laughs when I laugh (and smiles
almost always, regardless).
This script (Version 1.0) may be distributed freely (but it isn't a
whole lot of use without COM-AND). Any improvements that are
returned to the author will get attention... errors reported to the
author will be corrected. COM-AND is shareware. If COM-AND is USED
after a reasonable period of evaluation, a registration of $35.00 is
required.
Most of the hardware names and software names in this document are
trademarks or trade names of specific manufacturers.
Version 1.0: 891009
COM-AND Scripted BBS Page 11
A. Required and optional files
(1) Files in subdirectory \BBS
BBS-USER ID/Password file (required)
BBS-NOTE Comments/registrations - created if D.N.E
BBS-LOG Log of usage - created if D.N.E
(2) Optional Files in subdirectory \BBS
BBS-Welc Welcome message
BBS-NpMe Non-privileged user main menu
BBS-PrMe Privileged user main menu
BBS-PpMe Privileged user privileged submenu
BBS-NoMe Message displayed when NOTE requested
BBS-ReMe Message displayed when REGISTER requested
BBS-FiMe All users: files submenu
BBS-MeMe All users: mail submenu
BBS-BuMe All users: bulletins submenu
(3) Optional files in subdirectory \BBS\Mail
BBS-MAIL Points to existing and deleted messages
(4) Optional files in subdirectory \BBS\Files
BBS-FILE Points to files uploaded and downloadable
(5) Optional files in subdirectory \BBS\Bulletin
BBS-BULL Points to available bulletins
Version 1.0: 891009 Appendices
COM-AND Scripted BBS Page 12
B. File Structures
(1) \BBS\BBS-User (User IDs/passwords)
The BBS-User file is structured:
0 8 16 17
+---/ /---+---/ /---+--+---/ /---+---/ /---+---/ /---+
! ID ! Passwd ! ! Comments !
+---/ /---+---/ /---+--+---/ /---+---/ /---+---/ /---+
^Privilege flag = P
"<" in column 1 indicates a comment line; comments ignored
(2) \BBS\Mail\BBS-MAIL (Mail items)
The BBS-MAIL file is structured:
0 8 16 17 25 38
+---/ /---+---/ /---+--+---/ /---+---/ /---+-------/ /--------+
! To ID ! From ID ! ! Date ! Fname ! Subject (40 char)!
+---/ /---+---/ /---+--+---/ /---+---/ /---+-------/ /--------+
^Privacy flag = P
"*" in column 1 indicates a comment line; comments not printed
(3) \BBS\Bulletin\BBS-BULL (Bulletin items)
The BBS-BULL file is structured:
0 5 13 14 26
+---/ /---+---/ /---+--+---/ /---+-------/ /--------+
! Number ! Date ! ! Fname ! Subject (40 char)!
+---/ /---+---/ /---+--+---/ /---+-------/ /--------+
^Privileged access if nonblank
"*" in column 1 indicates a comment line; comments not printed
(4) \BBS\File\BBS-FILE (File items)
The BBS-FILE file is structured:
0 13 20 21 28
+---/ /---+---/ /---+--+---/ /---+-------/ /--------+
! Fname ! Date ! ! Size ! Description !
+---/ /---+---/ /---+--+---/ /---+-------/ /--------+
^ Privilege req'd if non-blank
"*" in column 1 indicates a comment line; comments are printed
Version 1.0: 891009 Appendices
COM-AND Scripted BBS Page 13
C. Maintenance
(1) Registrations
Registrations are not automatically entered into the BBS-User
file. The registrations exist as comments in the BBS-NOTE file.
A registering user is asked for a password and an ID. IDs
may not contain "."s, by the way. The SYSOP must add a record
to the BBS-User file to activate the ID.
(2) Mail
The Mail routines depend on the file BBS-MAIL in the \BBS\Mail
subdirectory for finding messages. The BBS does not update the
BBS-MAIL file upon deletion - the logic detects a deleted file
and skips the record.
However, with many deleted mail messages, list, scan, and read
will slow down percetibly. Records in BBS-MAIL pointing to
messages (files) which do not exist should be eliminated
regularly.
(3) Bulletins
If the file BBS-BULL does not exist on the subdirectory
\BBS\BULLETIN, the caller will be informed there are no bull-
etins. BBS-BULL must be created to support the Bulletin
function. Again, records in BBS-BULL that do not point to
existing text files are skipped by the logic.
(4) Files (uploads and downloads)
The file BBS-FILE in the subdirectory \BBS\FILES will be auto-
matically created upon the first upload. However, comments in
this file are displayed and may be used for informational pur-
poses. If you want these comments, they must be added manually.
Uploads are always added at the end of the file. They may be
moved.
Version 1.0: 891009 Appendices
COM-AND Scripted BBS Page 14
D. Modem Configuration
COM-AND default values do not require your modem to be configured
in any particular manner. However, certain features cannot be used
unless you configure your modem before you use COM-AND.
1. DTR (Data Terminal Ready)
COM-AND, by default, hangs up using the command sequences defined
through the Alt-S setup (hangup and modem escape). However, you
may alternately select 'Drop DTR to hangup' through the Alt-O
options. Dropping DTR is the only way to hangup certain modems,
and is generally much faster than the command sequences.
Most Hayes compatible modems allow configuration of the DTR sense
through a switch-block. If you wish to use DTR to hangup, be sure
that your modem follows the DTR signal. Refer to the documenta-
tion provided with your modem to be sure that option switches are
set appropriately.
2. CD (Carrier Detect)
COM-AND (presently) uses the CD sense line for several purposes.
The 'CONNECTED' test supported in the script language, test for
carrier detect upon exit, and the file transfer protocols all
require that the modem report carrier detect. True carrier detect
is the only way to determine if you are 'on-line' or 'off-line'.
Many Hayes compatible modems are sold with a carrier detect
override (in other words the modem reports carrier detect all the
time). When carrier detect is overridden, COM-AND cannot detect
when carrier is lost during a file transfer or whether to ask if
you want to hangup when you exit.
Be sure that the modem is reporting true CD (instead of it just
saying 'yes'). Most Hayes compatible modems allow configuration
of the CD sense through a switch-block. Refer to the documenta-
tion provided with your modem to be sure that option switches are
set appropriately.
Version 1.0: 891009 Appendices
COM-AND Scripted BBS Page 15
D. Sample files
1. BBS-USER
--------
<------------------------------------------------------------------>
< Comment entries begin '<'; Case is not signifigant in IDs
< and passwords. ID field begins in column 1.
<
<- ID ->< Pass >P<---------- Comments ----------------------------->
Scott xxxxxxxxP
2. BBS-BULL
--------
********************************************************************
* Comment entries begin '*'; Each entry points to a file (nnn).
* Each entry is numbered explicitly (###).
*
*####ddddddddfnnnnnnnnnnnnddddddddddddddddddddddddddddddddddddddddd*
********************************************************************
1 4/05/88 BULL.1 ISENGARD BBS's ANSI display
3. BBS-MAIL (created automatically)
--------
ALL SCOTT 4/06/88ALL.1 This board
4. BBS-FILE (created automatically, but nice to post initially)
--------
*
* Board related files
*
BBS-SRC.CMD 4/05/88 Source code for this BBS
*
* Uploads
*
Version 1.0: 891009 Appendices